<html>
<head>
<title>Docs For Class BaseValidator</title>
<link rel="stylesheet" type="text/css" href="../../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">kassiop-system-validators</td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                                                                                                                                            
                              		  [ <a href="../../classtrees_kassiop-system-validators.html" class="menu">class tree: kassiop-system-validators</a> ]
		  [ <a href="../../elementindex_kassiop-system-validators.html" class="menu">index: kassiop-system-validators</a> ]
		  	    [ <a href="../../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="../../li_kassiop.html">kassiop</a><br />
              <a href="../../li_kassiop-core.html">kassiop-core</a><br />
              <a href="../../li_kassiop-managers.html">kassiop-managers</a><br />
              <a href="../../li_kassiop-net.html">kassiop-net</a><br />
              <a href="../../li_kassiop-system.html">kassiop-system</a><br />
              <a href="../../li_kassiop-system-data.html">kassiop-system-data</a><br />
              <a href="../../li_kassiop-system-validators.html">kassiop-system-validators</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	subpackage <b>base</b><br>  <div class="package">
			<a href="../../kassiop-system-validators/base/_system---validators---base---BaseValidator.php.html">		BaseValidator.php
		</a><br>
			<a href="../../kassiop-system-validators/base/_system---validators---base---DatabaseValidator.php.html">		DatabaseValidator.php
		</a><br>
			<a href="../../kassiop-system-validators/base/_system---validators---base---ErrorBaseValidator.php.html">		ErrorBaseValidator.php
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
	base<br />	    &nbsp;&nbsp;		<a href="../../kassiop-system-validators/base/BaseValidator.html">BaseValidator</a><br />
	    &nbsp;&nbsp;		<a href="../../kassiop-system-validators/base/DatabaseValidator.html">DatabaseValidator</a><br />
	    &nbsp;&nbsp;		<a href="../../kassiop-system-validators/base/ErrorBaseValidator.html">ErrorBaseValidator</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: BaseValidator</h1>
Source Location: /system/validators/base/BaseValidator.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">The main class of all validators.</div><br /><br />
<h4>Author(s):</h4>
<ul>
          <li>NairuS</li>
                  </ul>




        
        
<h4>Version:</h4>
<ul>
  <li>1.2 $Rev: 90 $ $Date: 2011-01-16 10:23:26 +0100 (Dim, 16 jan 2011) $ $Author: nicolas.surian $</li>
</ul>

        
</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$charset">$charset</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$emptyValueKey">$emptyValueKey</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$invalidKey">$invalidKey</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$invalidMessage">$invalidMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$messages">$messages</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$options">$options</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$requiredKey">$requiredKey</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$requiredMessage">$requiredMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#var$trimKey">$trimKey</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#method__construct">__construct</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodaddMessage">addMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodaddOption">addOption</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodclean">clean</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodconfigure">configure</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methoddoClean">doClean</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetCharset">getCharset</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetEmptyValue">getEmptyValue</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetMessage">getMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetMessages">getMessages</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetOption">getOption</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodgetOptions">getOptions</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodhasMessage">hasMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodhasOption">hasOption</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodisEmpty">isEmpty</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodsetCharset">setCharset</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodsetMessage">setMessage</a></li>
    <li><a href="../../kassiop-system-validators/base/BaseValidator.html#methodsetOption">setOption</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>


<td valign="top">
<h3>Child classes:</h3>
<div class="tags">
<dl>
<dt><a href="../../kassiop-system-validators/base/DatabaseValidator.html">DatabaseValidator</a></dt>
	<dd>The class of all database validators.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/BooleanValidator.html">BooleanValidator</a></dt>
	<dd>The booleans validator.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/ChoiceValidator.html">ChoiceValidator</a></dt>
	<dd>The choices validator.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/DateValidator.html">DateValidator</a></dt>
	<dd>The date validator.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/FieldsCompareValidator.html">FieldsCompareValidator</a></dt>
	<dd>The fields compare validator.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/FileValidator.html">FileValidator</a></dt>
	<dd>FileValidator validates an uploaded file.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/IntegerValidator.html">IntegerValidator</a></dt>
	<dd>The integers validator.</dd>
</dl>
<dl>
<dt><a href="../../kassiop-system/validators/StringValidator.html">StringValidator</a></dt>
	<dd>The strings validator.</dd>
</dl>
</div>
</td>




</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 46]<br />
The main class of all validators.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>NairuS</td>
  </tr>
  <tr>
    <td><b>version:</b>&nbsp;&nbsp;</td><td>1.2 $Rev: 90 $ $Date: 2011-01-16 10:23:26 +0100 (Dim, 16 jan 2011) $ $Author: nicolas.surian $</td>
  </tr>
  <tr>
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$charset"></a>
	<p></p>
	<h4>static $charset = <span class="value">&nbsp;&quot;UTF-8&quot;&nbsp;</span></h4>
	<p>[line 124]</p>
  Defines the default charset of the string to validate.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$emptyValueKey"></a>
	<p></p>
	<h4>static $emptyValueKey = <span class="value">&nbsp;&quot;emptyValue&quot;&nbsp;</span></h4>
	<p>[line 96]</p>
  Defines the name of empty value option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$invalidKey"></a>
	<p></p>
	<h4>static $invalidKey = <span class="value">&nbsp;&quot;invalid&quot;&nbsp;</span></h4>
	<p>[line 103]</p>
  Defines the name of invalid option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$invalidMessage"></a>
	<p></p>
	<h4>static $invalidMessage = <span class="value">&nbsp;&quot;Invalid.&quot;&nbsp;</span></h4>
	<p>[line 131]</p>
  Defines the default invalid message to display.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$requiredKey"></a>
	<p></p>
	<h4>static $requiredKey = <span class="value">&nbsp;&quot;required&quot;&nbsp;</span></h4>
	<p>[line 110]</p>
  Defines the name of required option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$requiredMessage"></a>
	<p></p>
	<h4>static $requiredMessage = <span class="value">&nbsp;&quot;Required.&quot;&nbsp;</span></h4>
	<p>[line 138]</p>
  Defines the default required message to display.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$trimKey"></a>
	<p></p>
	<h4>static $trimKey = <span class="value">&nbsp;&quot;trim&quot;&nbsp;</span></h4>
	<p>[line 117]</p>
  Defines the name of trim option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$messages"></a>
	<p></p>
	<h4>$messages = <span class="value">array()</span></h4>
	<p>[line 145]</p>
  Defines the messages of the options.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>array</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$options"></a>
	<p></p>
	<h4>$options = <span class="value">array()</span></h4>
	<p>[line 152]</p>
  Defines the options of the validator.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>array</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodgetCharset"></a>
	<h3>static method getCharset <span class="smalllinenumber">[line 159]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>static string getCharset(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the charset to use when validating strings.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The charset (default to UTF-8)</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetCharset"></a>
	<h3>static method setCharset <span class="smalllinenumber">[line 169]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>static void setCharset(
string
$charset)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the charset to use when validating strings.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$charset</b>&nbsp;&nbsp;</td>
        <td>The charset</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>

  <hr />
	<a name="method__construct"></a>
	<h3>constructor __construct <span class="smalllinenumber">[line 64]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>BaseValidator __construct(
[
$options = array()], [
$messages = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Create an instance of BaseValidator<br /><br /><p>Available options:</p><p>required:    true if the value is required, false otherwise (default to true)  trim:        true if the value must be trimmed, false otherwise (default to true)  empty_value: empty value when value is not required</p><p>Available error codes:</p><p>required</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../../kassiop-system/validators/FieldsCompareValidator.html#method__construct">FieldsCompareValidator::__construct()</a></dt>
		<dd>Creates an instance of FieldsCompareValidator</dd>
	</dl>
	</p>
	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$options</b>&nbsp;&nbsp;</td>
        <td>An array of options</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$messages</b>&nbsp;&nbsp;</td>
        <td>An array of error messages</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodaddMessage"></a>
	<h3>method addMessage <span class="smalllinenumber">[line 313]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void addMessage(
string
$name, string
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Adds an message.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The message name.</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The message value.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodaddOption"></a>
	<h3>method addOption <span class="smalllinenumber">[line 325]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void addOption(
string
$name, [mixed
$value = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Adds an option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The option name.</td>
      </tr>
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The option value.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodclean"></a>
	<h3>method clean <span class="smalllinenumber">[line 186]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed clean(
mixed
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Cleans the input value.<br /><br /><p>This method is also responsible for trimming the input value  and checking the required option.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The cleaned value</td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>ErrorBaseValidator</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The input value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodconfigure"></a>
	<h3>method configure <span class="smalllinenumber">[line 344]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void configure(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Configures the current validator.<br /><br /><p>This method overrided allows each validator to add options and error messages  during validator creation.</p><p>If some options and messages are given in the ValidatorBase constructor  they will take precedence over the options and messages you configure  in this method.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../kassiop-system-validators/base/BaseValidator.html#method__construct">BaseValidator::__construct()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../../kassiop-system-validators/base/DatabaseValidator.html#methodconfigure">DatabaseValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/ChoiceDatabaseValidator.html#methodconfigure">ChoiceDatabaseValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/UniqueValidator.html#methodconfigure">UniqueValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/BooleanValidator.html#methodconfigure">BooleanValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/ChoiceValidator.html#methodconfigure">ChoiceValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/DateValidator.html#methodconfigure">DateValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/DateTimeValidator.html#methodconfigure">DateTimeValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FieldsCompareValidator.html#methodconfigure">FieldsCompareValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FileValidator.html#methodconfigure">FileValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/IntegerValidator.html#methodconfigure">IntegerValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FloatValidator.html#methodconfigure">FloatValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/StringValidator.html#methodconfigure">StringValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/RegexValidator.html#methodconfigure">RegexValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/EmailValidator.html#methodconfigure">EmailValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/SlugValidator.html#methodconfigure">SlugValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/UriValidator.html#methodconfigure">UriValidator::configure()</a></dt>
		<dd>Configures the current validator.</dd>
	</dl>
	</p>
	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddoClean"></a>
	<h3>method doClean <span class="smalllinenumber">[line 359]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed doClean(
mixed
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Cleans the input value.<br /><br /><p>Every subclass must implements this method.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The cleaned value</td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>ErrorBaseValidator</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../../kassiop-system-validators/base/DatabaseValidator.html#methoddoClean">DatabaseValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/ChoiceDatabaseValidator.html#methoddoClean">ChoiceDatabaseValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/UniqueValidator.html#methoddoClean">UniqueValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/BooleanValidator.html#methoddoClean">BooleanValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/ChoiceValidator.html#methoddoClean">ChoiceValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/DateValidator.html#methoddoClean">DateValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/DateTimeValidator.html#methoddoClean">DateTimeValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FieldsCompareValidator.html#methoddoClean">FieldsCompareValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FileValidator.html#methoddoClean">FileValidator::doClean()</a></dt>
		<dd>This validator always returns a ValidatedFile object.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/IntegerValidator.html#methoddoClean">IntegerValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/FloatValidator.html#methoddoClean">FloatValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/StringValidator.html#methoddoClean">StringValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
		<dl>
	<dt><a href="../../kassiop-system/validators/RegexValidator.html#methoddoClean">RegexValidator::doClean()</a></dt>
		<dd>Cleans the input value.</dd>
	</dl>
	</p>
	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The input value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetEmptyValue"></a>
	<h3>method getEmptyValue <span class="smalllinenumber">[line 380]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getEmptyValue(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns an empty value for this validator.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The empty value for this validator</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetMessage"></a>
	<h3>method getMessage <span class="smalllinenumber">[line 216]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getMessage(
string
$name)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the value of the message name passed-in or null if not exists.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The message value or null if not exists.</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The message name.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetMessages"></a>
	<h3>method getMessages <span class="smalllinenumber">[line 226]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getMessages(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return all the messages configured.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetOption"></a>
	<h3>method getOption <span class="smalllinenumber">[line 237]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getOption(
string
$name)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the value of the option name passed-in or null if not exists.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>The option value or null if not exists.</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The option name.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetOptions"></a>
	<h3>method getOptions <span class="smalllinenumber">[line 247]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getOptions(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return all the options configured.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodhasMessage"></a>
	<h3>method hasMessage <span class="smalllinenumber">[line 258]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean hasMessage(
string
$name)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns true if the message name exists.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The message name to check.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodhasOption"></a>
	<h3>method hasOption <span class="smalllinenumber">[line 269]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean hasOption(
string
$name)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns true if the option name exists.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The option name to check.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisEmpty"></a>
	<h3>method isEmpty <span class="smalllinenumber">[line 370]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>bool isEmpty(
mixed
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns true if the value is empty.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>true if the value is empty, false otherwise</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../../kassiop-system/validators/FileValidator.html#methodisEmpty">FileValidator::isEmpty()</a></dt>
		<dd>Returns true if the value is empty.</dd>
	</dl>
	</p>
	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The input value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetMessage"></a>
	<h3>method setMessage <span class="smalllinenumber">[line 281]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setMessage(
string
$name, string
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Tries to set an existant message.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The message name</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The message value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetOption"></a>
	<h3>method setOption <span class="smalllinenumber">[line 297]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setOption(
string
$name, mixed
$value)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Tries to set an existant option.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$name</b>&nbsp;&nbsp;</td>
        <td>The option name</td>
      </tr>
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$value</b>&nbsp;&nbsp;</td>
        <td>The option value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Thu, 20 Jan 2011 14:38:56 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>